<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Retro 2012: Retro.Model.core.Shape Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="retro.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Retro 2012
   &#160;<span id="projectnumber">v2.3</span>
   </div>
   <div id="projectbrief">Clustering, Visualization, Transcription &amp; Typographic studies Software</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00160.html">Retro</a>      </li>
      <li class="navelem"><a class="el" href="a00162.html">Model</a>      </li>
      <li class="navelem"><a class="el" href="a00163.html">core</a>      </li>
      <li class="navelem"><a class="el" href="a00048.html">Shape</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="#events">Events</a>  </div>
  <div class="headertitle">
<div class="title">Retro.Model.core.Shape Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Retro::Model::core::Shape" -->
<p>Represent a connected component created by the <a class="el" href="a00158.html">Clustering</a> step.  
 <a href="a00048.html#details">More...</a></p>

<p><a href="a00231.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a972cf72bb4f88d14b58cec91607bb2e2">Shape</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a972cf72bb4f88d14b58cec91607bb2e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#aad787a5aa802bb8600e7ffcf7405185e">Shape</a> (String shapeID, String clusterID, String shapeDirectory, String altoDirectory)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aad787a5aa802bb8600e7ffcf7405185e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">override String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ab7e02d9fcc5c16f6c163d5f410e4754d">ToString</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">For Display purpose in GUI ListBox.  <a href="#ab7e02d9fcc5c16f6c163d5f410e4754d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ae09d822351cb8e8dbe3fc11e6a9fffe2">ShapeId</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">ID of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> (correspond to the normalized ID in alto file)  <a href="#ae09d822351cb8e8dbe3fc11e6a9fffe2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#af23b95955e28db7e9b6e14d423e8d24e">ShapePath</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Path of the shapes thumbnails.  <a href="#af23b95955e28db7e9b6e14d423e8d24e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a8df1822dada0a1dda1ea079b9ccfab99">ImageSourceID</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the source image where this shape belong (correspond to the normalized name of Agora output)  <a href="#a8df1822dada0a1dda1ea079b9ccfab99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a0fba020dd661917fbd1c2977ec96f521">ClusterId</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">ID of the cluster.  <a href="#a0fba020dd661917fbd1c2977ec96f521"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#afd79dc122ada2188dc0bf409838c0ff7">X</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Top Left corner x-axis of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box.  <a href="#afd79dc122ada2188dc0bf409838c0ff7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a411eb23695bfaa68bfb6798a862eeffd">Y</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Top Left corner y-axis of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box.  <a href="#a411eb23695bfaa68bfb6798a862eeffd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a559828952779f141d12ee0068adce486">Height</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Height of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box.  <a href="#a559828952779f141d12ee0068adce486"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a97d45cbad676b99872a1e3bf0a38ac61">Width</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Width of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box.  <a href="#a97d45cbad676b99872a1e3bf0a38ac61"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="events"></a>
Events</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PropertyChangedEventHandler&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a8d8fb8487f2f1f4219491952b7db4507">PropertyChanged</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">For binding purpose.  <a href="#a8d8fb8487f2f1f4219491952b7db4507"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represent a connected component created by the <a class="el" href="a00158.html">Clustering</a> step. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a972cf72bb4f88d14b58cec91607bb2e2"></a><!-- doxytag: member="Retro::Model::core::Shape::Shape" ref="a972cf72bb4f88d14b58cec91607bb2e2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Retro.Model.core.Shape.Shape </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default Constructor. </p>

</div>
</div>
<a class="anchor" id="aad787a5aa802bb8600e7ffcf7405185e"></a><!-- doxytag: member="Retro::Model::core::Shape::Shape" ref="aad787a5aa802bb8600e7ffcf7405185e" args="(String shapeID, String clusterID, String shapeDirectory, String altoDirectory)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Retro.Model.core.Shape.Shape </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>shapeID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>clusterID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>shapeDirectory</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>altoDirectory</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">shapeID</td><td><a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> id</td></tr>
    <tr><td class="paramname">clusterID</td><td><a class="el" href="a00013.html" title="Represent a Cluster.">Cluster</a> id</td></tr>
    <tr><td class="paramname">shapeDirectory</td><td>Path of the shape exported by AGORA</td></tr>
    <tr><td class="paramname">altoDirectory</td><td>Path of the alto/ directory</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab7e02d9fcc5c16f6c163d5f410e4754d"></a><!-- doxytag: member="Retro::Model::core::Shape::ToString" ref="ab7e02d9fcc5c16f6c163d5f410e4754d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override String Retro.Model.core.Shape.ToString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>For Display purpose in GUI ListBox. </p>

</div>
</div>
<hr/><h2>Property Documentation</h2>
<a class="anchor" id="a0fba020dd661917fbd1c2977ec96f521"></a><!-- doxytag: member="Retro::Model::core::Shape::ClusterId" ref="a0fba020dd661917fbd1c2977ec96f521" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String Retro.Model.core.Shape.ClusterId<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>ID of the cluster. </p>

</div>
</div>
<a class="anchor" id="a559828952779f141d12ee0068adce486"></a><!-- doxytag: member="Retro::Model::core::Shape::Height" ref="a559828952779f141d12ee0068adce486" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Retro.Model.core.Shape.Height<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Height of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box. </p>

</div>
</div>
<a class="anchor" id="a8df1822dada0a1dda1ea079b9ccfab99"></a><!-- doxytag: member="Retro::Model::core::Shape::ImageSourceID" ref="a8df1822dada0a1dda1ea079b9ccfab99" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String Retro.Model.core.Shape.ImageSourceID<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Name of the source image where this shape belong (correspond to the normalized name of Agora output) </p>

</div>
</div>
<a class="anchor" id="ae09d822351cb8e8dbe3fc11e6a9fffe2"></a><!-- doxytag: member="Retro::Model::core::Shape::ShapeId" ref="ae09d822351cb8e8dbe3fc11e6a9fffe2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String Retro.Model.core.Shape.ShapeId<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>ID of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> (correspond to the normalized ID in alto file) </p>

</div>
</div>
<a class="anchor" id="af23b95955e28db7e9b6e14d423e8d24e"></a><!-- doxytag: member="Retro::Model::core::Shape::ShapePath" ref="af23b95955e28db7e9b6e14d423e8d24e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String Retro.Model.core.Shape.ShapePath<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Path of the shapes thumbnails. </p>

</div>
</div>
<a class="anchor" id="a97d45cbad676b99872a1e3bf0a38ac61"></a><!-- doxytag: member="Retro::Model::core::Shape::Width" ref="a97d45cbad676b99872a1e3bf0a38ac61" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Retro.Model.core.Shape.Width<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Width of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box. </p>

</div>
</div>
<a class="anchor" id="afd79dc122ada2188dc0bf409838c0ff7"></a><!-- doxytag: member="Retro::Model::core::Shape::X" ref="afd79dc122ada2188dc0bf409838c0ff7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Retro.Model.core.Shape.X<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Top Left corner x-axis of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box. </p>

</div>
</div>
<a class="anchor" id="a411eb23695bfaa68bfb6798a862eeffd"></a><!-- doxytag: member="Retro::Model::core::Shape::Y" ref="a411eb23695bfaa68bfb6798a862eeffd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Retro.Model.core.Shape.Y<code> [get, set]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Top Left corner y-axis of the <a class="el" href="a00048.html" title="Represent a connected component created by the Clustering step.">Shape</a> bounding box. </p>

</div>
</div>
<hr/><h2>Event Documentation</h2>
<a class="anchor" id="a8d8fb8487f2f1f4219491952b7db4507"></a><!-- doxytag: member="Retro::Model::core::Shape::PropertyChanged" ref="a8d8fb8487f2f1f4219491952b7db4507" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PropertyChangedEventHandler Retro.Model.core.Shape.PropertyChanged</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>For binding purpose. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00148.html">Shape.cs</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Events</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Dec 7 2012 18:27:17 for Retro 2012 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
